lite-fw.h

Go to the documentation of this file.

#ifndef _LITE_FW_H_
#define _LITE_FW_H_

#ifdef __cplusplus
extern "C" {
#endif

/* Pragmas */
#pragma once
#include "qmerrno.h"
#include "fms.h"
#include "dms.h"

#define IMG_MASK_MDM (1<<0)
#define IMG_MASK_PRI (1<<1)
#define IMG_MASK_CLEAR   (0x000)
#define IMG_MASK_GENERIC (0xFFFF)

// Carrier package SKU Info
#define LITEFW_CARRIER_PACKAGE_SKU "9999999"
#define LITEFW_SKU_STRING_LENGTH   7

// Fimware Info String size
#define FIRMWARE_INFO_STRING_SIZE  20
#define NULL_TERMINATOR_CHAR_SIZE  1
#define FIRMWARE_IMAGE_SIZE_MAX    512
#define FIRMWARE_BCHVERSTRSIZE     84
#define FIRMWARE_BCHDATESIZE       8
#define MAX_IMAGE_PRODUCT_LENGTH   10

/* error Codes */
enum litefw_fwdwl_error_codes
{
    eSDP_FWDWL_SUCCESS = 0,             //       Success
    eSDP_FWDWL_ERR_GENERAL = 100,       // 100 - Generic FW download error
    eSDP_FWDWL_ERR_SDK,                 // 101 - SDK specific error. Please check syslog for SDK error codes
    eSDP_FWDWL_ERR_SET_CBK,             // 102 - Error in setting SDK callbacks
    eSDP_FWDWL_ERR_PATH_TOO_LONG,       // 103 - Path is too long
    eSDP_FWDWL_ERR_PATH_NOT_SPECIFIED,  // 104 - Mandatory SDK/FW path not set
    eSDP_FWDWL_ERR_FW_UPGRADE,          // 105 - Post FW download check indicates that the FW upgrade has failed. 
                                        //       For example, PRI not updated as expected, FW version not updated etc
    eSDP_FWDWL_ERR_INVALID_DEV,         // 106 - Invalid device
    eSDP_FWDWL_ERR_INVALID_PATH,        // 107 - Invalid Path or No valid firmware or nvu file exist in the path
    eSDP_FWDWL_ERR_TIMEOUT,             // 108 - Download Process Timeout
    eSDP_FWDWL_ERR_FAIL,                // 109 - Download Process Fail
    eSDP_FWDWL_ERR_PRI_FAIL,            // 110 - Download PRI Fail
    eSDP_FWDWL_ERR_FW_VERSION_FAIL,     // 111 - Download Fail Version Not Match
    eSDP_FWDWL_ERR_SDP_TIMEOUT,         // 112 - SSDP mode timeout
    eFIREHOSE_ERR_SECBOOT_INVALID_CERT_CHAIN,// 113 - Secure boot invalid certificate chain
    eFIREHOSE_ERR_RC7611_RETRY_TEST,// 114 - RC7611 swtich to firehose mode fail
    eLITE_FWDWL_APP_ERR_RC7611_ERROR_AFTER_RETRY,// 115 RC7611 switch to firehose mode failed after retry
    eSDP_FWDWL_ERR_END
};

// Match this enum with fw_image_type_e in imudefs.h
enum litefw_Fw_Type{
    eFW_TYPE_MBN_GOBI, // Not supported in litefw
    eFW_TYPE_MBN,      // Not supported in litefw
    eFW_TYPE_CWE,      //CWE File
    eFW_TYPE_NVU,      //NVU File
    eFW_TYPE_SPK,      //SPK File
    eFW_TYPE_INVALID,  //Invalid File
    eFW_TYPE_CWE_NVU,  //CWE and NVU
};


/*************
 *
 * Name:     litefw_fileimgtype
 *
 * Purpose:  Enumerate different PRI type
 *
 * Members:  eFILE_TYPE_NONE       - Start of list
 *           eFILE_TYPE_CAR_PRI    - Carrier PRI file (file name starts with &ldquo;9999999_&rdquo;)
 *           eFILE_TYPE_OEM_PRI    - OEM PRI file     (file name strats with valid SKU such as &ldquo;1104125_&rdquo;)
 *           eFILE_TYPE_COMPO_PRI  - A compound PRI files contain both Carrier PRI and OEM PRI
 */
enum litefw_fileimgtype
{
    eFILE_TYPE_NONE = 0,
    eFILE_TYPE_CAR_PRI,
    eFILE_TYPE_OEM_PRI,
    eFILE_TYPE_COMPO_PRI
};

/*************
 *
 * Name:     litefw_bcimagetype
 *
 * Purpose:  Enumerate some supported BC image types
 *
 * Members:  eIMAGE_TYPE_MIN       - Start of list
 *           eIMAGE_TYPE_BOOT      - boot composite image
 *           eIMAGE_TYPE_APPL      - application composite image
 *           eIMAGE_TYPE_AMSS      - amss
 *           eIMAGE_TYPE_APPS      - apps such as yocto image
 *           eIMAGE_TYPE_FILE      - Generic file such as Carrier PRI
 *           eIMAGE_TYPE_SPKG      - Sierra package, spk image, OEM PRI image
 *           eIMAGE_TYPE_MODM      - modem composite image, modem firmware cwe image
 *           eIMAGE_TYPE_USER      - image for 0:USERDATA, e.g. legato
 *           eIMAGE_TYPE_KEYS,     - Keystore image, signed key information
 *           eIMAGE_TYPE_MAX       - End of list
 *           eIMAGE_TYPE_INVALID   - invalid image type
 *           eIMAGE_TYPE_ANY       - any image type
 *
 * Notes:    none
 *
 **************/
enum litefw_imagetype
{
  eIMAGE_TYPE_MIN = 0,
  eIMAGE_TYPE_BOOT = eIMAGE_TYPE_MIN,
  eIMAGE_TYPE_APPL,
  eIMAGE_TYPE_APPS,
  eIMAGE_TYPE_FILE,
  eIMAGE_TYPE_SPKG,
  eIMAGE_TYPE_MODM,
  eIMAGE_TYPE_USER,
  eIMAGE_TYPE_KEYS,
  eIMAGE_TYPE_MAX,
  eIMAGE_TYPE_INVALID = 0xFF,
  eIMAGE_TYPE_ANY = eIMAGE_TYPE_INVALID,
};


/* Model Family */
enum litefw_Models{
    eModel_Unknown=-1,
    eModel_9X15=0,
    eModel_WP9X15=1,
    eModel_9X30=2,
    eModel_9x07=3,
    eModel_9x06=4,
    eModel_9x05=5,
};

/* QDL mode */
enum litefw_QDL_MODEs{
    eQDL_MODE_Unknown=-1,
    eQDL_MODE_INIT=0,
    eQDL_MODE_TTYUSB=1,
    eQDL_MODE_UART0=2,
};

/* QDL mode Hardware flow control */
enum litefw_QDL_FLOW_CONTROLs{
    eQDL_HW_FLOW_Unknown=-1,
    eQDL_HW_FLOW_INIT=0,
    eQDL_HW_FLOW_ENABLE=1,
    eQDL_HW_FLOW_DISABLE=2,
};

void litefw_logsenable(int log_en);

typedef struct _litefw_FirmwareInfo_
{
    char szModelid_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
    char szFwversion_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
    char szSku_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
    char szPackageid_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
    char szCarrier_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
    char szCarrierPriversion_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
}litefw_FirmwareInfo;

typedef struct _litefw_FirmwarePartNo_
{
    char szPartno_str[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
}litefw_FirmwarePartNo;

typedef struct _litefw_FirmwareFileInfo
{
    char                    fullPath[FIRMWARE_IMAGE_SIZE_MAX];
    uint8_t                 imageMask;
    enum litefw_imagetype   headerType;
    enum litefw_fileimgtype imageType;
    char                    modelIdStr[FIRMWARE_INFO_STRING_SIZE + NULL_TERMINATOR_CHAR_SIZE];
    char                    partNoStr[FIRMWARE_INFO_STRING_SIZE+NULL_TERMINATOR_CHAR_SIZE];
    char                    skuStr[FIRMWARE_INFO_STRING_SIZE + NULL_TERMINATOR_CHAR_SIZE];
    char                    packageIdStr[FIRMWARE_INFO_STRING_SIZE + NULL_TERMINATOR_CHAR_SIZE];
    char                    carrierStr[FIRMWARE_INFO_STRING_SIZE + NULL_TERMINATOR_CHAR_SIZE];
    char                    priVersionStr[FIRMWARE_INFO_STRING_SIZE + NULL_TERMINATOR_CHAR_SIZE];
    char                    versionStr[FIRMWARE_BCHVERSTRSIZE];
    char                    releaseDate[FIRMWARE_BCHDATESIZE];;
}litefw_FirmwareFileInfo;

int litefw_ExtractFirmwareParametersByPath(char *pImagePath, litefw_FirmwareInfo *info);

int litefw_ExtractFirmwarePartNoByPath(char *pImagePath, litefw_FirmwarePartNo *partno);

int litefw_BuildImagesPreferenceRequest(litefw_FirmwareInfo info,pack_fms_SetImagesPreference_t *pack);

int litefw_CalculateImageMask (unpack_fms_SetImagesPreference_t SetPrefRspFromModem);

int litefw_getFileType(char* szPath);

unsigned int litefw_DownloadFW(char *pImagePath,char *szTTYPath,int iFWImageType, int image_mask, int iModelFamily);

int litefw_GetModelFamily(char *pModelString);

int litefw_CheckValidFirmwareInfo(litefw_FirmwareInfo info);


char* litefw_GetVersion();


typedef void (* litefwlogger)(uint8_t lvl, const char* buff);

int litefw_set_log_func(litefwlogger *func);

void litefw_SetReadBlockSize(unsigned long lBlockSize);


int litefw_switch_9x07_to_downloadmode(char *szTTYPath);


int litefw_switch_to_BootHoldMode(char *szTTYPath);

int litefw_SetQTLDownloadMode(int iMode);

int litefw_GetQTLDownloadMode();

int litefw_SetQTLHWFlowControl(int iMode);

int litefw_GetQTLHWFlowControl();

enum eQCWWANError  litefw_SLQSGetFirmwareFileInfo(
    char *fullFilePath,
    litefw_FirmwareFileInfo* info,
    uint8_t *pNumOfItems);


void litefw_SetRetryFirehoseSwitch(int mode);

int litefw_GetRetryFirehoseSwitch();


unsigned long GetFlashSectorSize();

void SetFlashSectorSize(unsigned long ulSize);

#define libSDP_GetVersion litefw_GetVersion
#define libSDP_CalculateImageMask litefw_CalculateImageMask
#define libSDP_getFileType litefw_getFileType
#define libSDP_ExtractFirmwareParametersByPath litefw_ExtractFirmwareParametersByPath
#define libSDP_GetModelFamily litefw_GetModelFamily
#define libSDP_CheckValidFirmwareInfo litefw_CheckValidFirmwareInfo
#define libSDP_BuildImagesPreferenceRequest litefw_BuildImagesPreferenceRequest
#define libSDP_DownloadFW litefw_DownloadFW
#define libsdp_set_log_func litefw_set_log_func
#define libsdp_SetReadBlockSize litefw_SetReadBlockSize
#define LIBSDP_CARRIER_PACKAGE_SKU LITEFW_CARRIER_PACKAGE_SKU
#define LIBSDP_SKU_STRING_LENGTH LITEFW_SKU_STRING_LENGTH
typedef litefw_FirmwareInfo libSDP_FirmwareInfo;
typedef litefwlogger libsdplogger;

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif // _LITE_FW_H_